home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / datatypes / binarydt / doc / binary_dtc.doc < prev    next >
Encoding:
Text File  |  1996-04-07  |  4.3 KB  |  123 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. binary.datatype/binary.datatype
  6.  
  7.  
  8. binary.datatype/binary.datatype                binary.datatype/binary.datatype
  9.  
  10.     NAME
  11.         binary.datatype -- data type for any binary file
  12.  
  13.     FUNCTION
  14.         The binary data type, a base-class of all binary data, is used to
  15.         load any binary file and displays the contents of the file in hex
  16.         format.
  17.  
  18.     PREFS
  19.         The data type tries to load the prefs file first from
  20.         "PROGDIR:Prefs/DataTypes/binary.prefs" and then
  21.         "ENV:DataTypes/binary.prefs" on each OM_NEW method to set up the
  22.         attributes !
  23.         Up from version 39.10 it uses the ReadArgs() function to parse the
  24.         prefs file. The template is :
  25.  
  26.         NOASCII/S,NOWRAP/S,NONE/S,BYTE/S,WORD/S,LONG/S,BPL=BYTESPERLINE/N/K
  27.  
  28.         NOASCII   - sets BDTA_ShowASCII to FALSE
  29.         NOWRAP    - sets BDTA_DisplayWrap to FALSE
  30.         NONE      - sets BDTA_DisplayHex to BDTDH_NONE
  31.         BYTE      - sets BDTA_DisplayHex to BDTDH_BYTE
  32.         WORD      - sets BDTA_DisplayHex to BDTDH_WORD
  33.         LONG      - sets BDTA_DisplayHex to BDTDH_LONG
  34.         BYTESPERLINE <bpl> or
  35.         BPL <bpl> - sets BDTA_BytesPerLine to <bpl> bytes
  36.  
  37.         The options can be on several lines !
  38.  
  39.     METHODS
  40.         OM_NEW -- Create a new text object from a binary file in hex mode.
  41.  
  42.         OM_DISPOSE -- dispose a object
  43.  
  44.         OM_GET -- get a attribute of the object
  45.  
  46.         OM_SET -- set attributes of the object
  47.  
  48.         OM_UPDATE -- update some attributes of the object
  49.  
  50.         GM_LAYOUT -- Method to layout the hex text
  51.  
  52.         GM_RENDER -- draw the object
  53.  
  54.         DTM_WRITE -- DTWM_RAW mode is supported
  55.  
  56.         DTM_PRINT -- prints the hex text
  57.  
  58.         DTM_DRAW -- draws the datatype in the given RastPort (This is
  59.             expermintal, I use this method for my new text.datatype to
  60.             embed other datatype objects ! Don't use this at the moment !)
  61.  
  62.         DTM_TRIGGER -- trigger methods to let the user input a search string
  63.             and to search next or previous occurence of that string :
  64.             STM_ACTIVATE_FIELD (return) - opens the string requester. This
  65.                 requester is spawned asyncronly !
  66.             STM_BROWSE_NEXT ('>') - searchs next occurence
  67.             STM_BROWSE_PREV ('<') - searchs previous occurence
  68.  
  69.         DTBM_GETSTRING -- opens a requester to let the user input the
  70.             string !
  71.  
  72.         DTBM_SEARCHNEXT -- searchs for the next occurence of the specified
  73.             string
  74.  
  75.         DTBM_SEARCHPREV -- searchs for the previous occurance of the given
  76.             string
  77.  
  78.     TAGS
  79.         BDTA_Buffer -- (UBYTE *) pointer to the buffer, which should be
  80.             displayed.
  81.             Applicability is (ISG).
  82.  
  83.         BDTA_BufferLen -- (ULONG) length of the buffer supplied with
  84.             BDTA_Buffer tag. This must be given if the buffer tag is
  85.             specified.
  86.             Applicability is (ISG).
  87.  
  88.         BDTA_BytesPerLine -- (UWORD) number of bytes per line.
  89.             If BDTA_DisplayHex is BDTDH_WORD it must be a multiply of 2,
  90.             if it is BDTDH_LONG it must be a multiply of 4 !
  91.             Default is 32.
  92.             Applicability is (ISGNU).
  93.  
  94.         BDTA_DisplayHex -- (UWORD) type of the display. The following types
  95.             are supported : BDTDH_NONE  - displays no hex values
  96.                             BDTDH_BYTE  - displays each byte in hex ( 8 bit)
  97.                             BDTDH_WORD  - displays each word in hex (16 bit)
  98.                             BDTDH_LONG  - displays each long in hex (32 bit)
  99.             Default is BDTDH_LONG.
  100.             Applicability is (ISGNU).
  101.  
  102.         BDTA_ShowASCII -- (BOOL) display at the end of the line the
  103.             appropriate ASCII string !
  104.             Default is TRUE.
  105.             Applicability is (ISGNU).
  106.  
  107.         BDTA_DisplayWrap -- (BOOL) the BDTA_BytesPerLine are ignored and the
  108.             byte number is retrieved from the object width !
  109.             Default is TRUE.
  110.             Applicability is (ISGNU).
  111.  
  112.         BDTA_Found -- (STRPTR) pointer to the buffer to highlight the line.
  113.             This is used to display the line of a found string !
  114.             Default is NULL
  115.             Applicability is (ISNU).
  116.  
  117.     BUGS
  118.         At the moment proportional fonts can't be handled.
  119.  
  120.     SEE ALSO
  121.         datatypesclass (where ?)
  122.  
  123.